<!DOCTYPE html>
<html lang="en-US">
<head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="language" content="en" />
        <link href="./assets/ffd55088/css/bootstrap.css" rel="stylesheet">
<link href="./assets/5cf9384a/solarized_light.css" rel="stylesheet">
<link href="./assets/6c54116e/style.css" rel="stylesheet">
<script src="./assets/a44cef0f/jquery.js"></script>
<script src="./assets/ffd55088/js/bootstrap.js"></script>
<script src="./assets/8ac4e28a/jssearch.js"></script>    <title>ActiveDataProvider, yii\elasticsearch\ActiveDataProvider - Yii Framework 2.0 API Documentation</title>
</head>
<body>

<div class="wrap">
    <nav id="w11629" class="navbar-inverse navbar-fixed-top navbar" role="navigation"><div class="navbar-header"><button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#w11629-collapse"><span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span></button><a class="navbar-brand" href="./index.html">Yii Framework 2.0 API Documentation</a></div><div id="w11629-collapse" class="collapse navbar-collapse"><ul id="w11630" class="navbar-nav nav"><li><a href="./index.html">Class reference</a></li>
<li class="dropdown"><a class="dropdown-toggle" href="#" data-toggle="dropdown">Extensions <b class="caret"></b></a><ul id="w11631" class="dropdown-menu"><li><a href="./ext-apidoc-index.html" tabindex="-1">apidoc</a></li>
<li><a href="./ext-authclient-index.html" tabindex="-1">authclient</a></li>
<li><a href="./ext-bootstrap-index.html" tabindex="-1">bootstrap</a></li>
<li><a href="./ext-codeception-index.html" tabindex="-1">codeception</a></li>
<li><a href="./ext-debug-index.html" tabindex="-1">debug</a></li>
<li><a href="./ext-elasticsearch-index.html" tabindex="-1">elasticsearch</a></li>
<li><a href="./ext-faker-index.html" tabindex="-1">faker</a></li>
<li><a href="./ext-gii-index.html" tabindex="-1">gii</a></li>
<li><a href="./ext-imagine-index.html" tabindex="-1">imagine</a></li>
<li><a href="./ext-jui-index.html" tabindex="-1">jui</a></li>
<li><a href="./ext-mongodb-index.html" tabindex="-1">mongodb</a></li>
<li><a href="./ext-redis-index.html" tabindex="-1">redis</a></li>
<li><a href="./ext-smarty-index.html" tabindex="-1">smarty</a></li>
<li><a href="./ext-sphinx-index.html" tabindex="-1">sphinx</a></li>
<li><a href="./ext-swiftmailer-index.html" tabindex="-1">swiftmailer</a></li>
<li><a href="./ext-twig-index.html" tabindex="-1">twig</a></li></ul></li>
<li><a href="./guide-README.html">Guide</a></li></ul><div class="navbar-form navbar-left" role="search">
  <div class="form-group">
    <input id="searchbox" type="text" class="form-control" placeholder="Search">
  </div>
</div>
</div></nav>
    <div id="search-resultbox" style="display: none;" class="modal-content">
        <ul id="search-results">
        </ul>
    </div>

    
<div class="row">
    <div class="col-md-3">
                <div id="navigation" class="list-group"><a class="list-group-item active" href="#navigation-11628" data-toggle="collapse" data-parent="#navigation">yii\elasticsearch <b class="caret"></b></a><div id="navigation-11628" class="submenu panel-collapse collapse in"><a class="list-group-item active" href="./yii-elasticsearch-activedataprovider.html">ActiveDataProvider</a>
<a class="list-group-item" href="./yii-elasticsearch-activefixture.html">ActiveFixture</a>
<a class="list-group-item" href="./yii-elasticsearch-activequery.html">ActiveQuery</a>
<a class="list-group-item" href="./yii-elasticsearch-activerecord.html">ActiveRecord</a>
<a class="list-group-item" href="./yii-elasticsearch-batchqueryresult.html">BatchQueryResult</a>
<a class="list-group-item" href="./yii-elasticsearch-bulkcommand.html">BulkCommand</a>
<a class="list-group-item" href="./yii-elasticsearch-command.html">Command</a>
<a class="list-group-item" href="./yii-elasticsearch-connection.html">Connection</a>
<a class="list-group-item" href="./yii-elasticsearch-debugaction.html">DebugAction</a>
<a class="list-group-item" href="./yii-elasticsearch-debugpanel.html">DebugPanel</a>
<a class="list-group-item" href="./yii-elasticsearch-exception.html">Exception</a>
<a class="list-group-item" href="./yii-elasticsearch-query.html">Query</a>
<a class="list-group-item" href="./yii-elasticsearch-querybuilder.html">QueryBuilder</a></div></div>    </div>
    <div class="col-md-9 api-content" role="main">
        <h1>Class yii\elasticsearch\ActiveDataProvider</h1>
<div class="top-nav">
    <a href="index.html">All Classes</a>
            | <a href="#properties">Properties</a>
                | <a href="#methods">Methods</a>
            </div>

<table class="summaryTable docClass table table-bordered">
    <colgroup>
        <col class="col-name" />
        <col class="col-value" />
    </colgroup>
            <tr><th>Inheritance</th><td><a href="yii-elasticsearch-activedataprovider.html">yii\elasticsearch\ActiveDataProvider</a> &raquo;
<a href="yii-data-activedataprovider.html">yii\data\ActiveDataProvider</a> &raquo;
<a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a> &raquo;
<a href="yii-base-component.html">yii\base\Component</a> &raquo;
<a href="yii-base-object.html">yii\base\Object</a></td></tr>
                <tr><th>Implements</th><td><a href="yii-base-configurable.html">yii\base\Configurable</a>, <a href="yii-data-dataproviderinterface.html">yii\data\DataProviderInterface</a></td></tr>
                                    <tr><th>Available since version</th><td>2.0.5</td></tr>
                    <tr>
          <th>Source Code</th>
          <td><a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveDataProvider.php">https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveDataProvider.php</a></td>
        </tr>
    </table>

<div class="class-description">
    <p><strong>ActiveDataProvider is an enhanced version of <a href="yii-data-activedataprovider.html">yii\data\ActiveDataProvider</a> specific to the ElasticSearch.</strong></p>
    <p>It allows to fetch not only rows and total rows count, but full query results including aggregations and so on.</p>
<p>Note: this data provider fetches result models and total count using single ElasticSearch query, so results total
count will be fetched after pagination limit applying, which eliminates ability to verify if requested page number
actually exist. Data provider disables <span class="broken-link">\yii\elasticsearch\yii\data\Pagination::validatePage</span> automatically because of this.</p>

    </div>

<a id="properties"></a>

<div class="summary doc-property">
<h2>Public Properties</h2>

<p><a href="#" class="toggle">Hide inherited properties</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-property" />
    <col class="col-type" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Property</th><th>Type</th><th>Description</th><th>Defined By</th>
</tr>
        <tr id="$aggregations">
        <td><a href="yii-elasticsearch-activedataprovider.html#$aggregations-detail">$aggregations</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>All aggregations results</td>
        <td><a href="yii-elasticsearch-activedataprovider.html">yii\elasticsearch\ActiveDataProvider</a></td>
    </tr>
            <tr class="inherited" id="$behaviors">
        <td><a href="yii-base-component.html#$behaviors-detail">$behaviors</a></td>
        <td><a href="yii-base-behavior.html">yii\base\Behavior</a>[]</td>
        <td>List of behaviors attached to this component</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="$count">
        <td><a href="yii-data-basedataprovider.html#$count-detail">$count</a></td>
        <td><a href="http://www.php.net/language.types.integer">integer</a></td>
        <td>The number of data models in the current page.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="$db">
        <td><a href="yii-data-activedataprovider.html#$db-detail">$db</a></td>
        <td><a href="yii-db-connection.html">yii\db\Connection</a>|<a href="http://www.php.net/language.types.array">array</a>|<a href="http://www.php.net/language.types.string">string</a></td>
        <td>The DB connection object or the application component ID of the DB connection.</td>
        <td><a href="yii-data-activedataprovider.html">yii\data\ActiveDataProvider</a></td>
    </tr>
            <tr class="inherited" id="$id">
        <td><a href="yii-data-basedataprovider.html#$id-detail">$id</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>An ID that uniquely identifies the data provider among all data providers.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="$key">
        <td><a href="yii-data-activedataprovider.html#$key-detail">$key</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.callable">callable</a></td>
        <td>The column that is used as the key of the data models.</td>
        <td><a href="yii-data-activedataprovider.html">yii\data\ActiveDataProvider</a></td>
    </tr>
            <tr class="inherited" id="$keys">
        <td><a href="yii-data-basedataprovider.html#$keys-detail">$keys</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The list of key values corresponding to <a href="yii-data-basedataprovider.html#$models-detail">$models</a>.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="$models">
        <td><a href="yii-data-basedataprovider.html#$models-detail">$models</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The list of data models in the current page.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="$pagination">
        <td><a href="yii-data-basedataprovider.html#$pagination-detail">$pagination</a></td>
        <td><a href="yii-data-pagination.html">yii\data\Pagination</a>|<a href="http://www.php.net/language.types.boolean">boolean</a></td>
        <td>The pagination object.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="$query">
        <td><a href="yii-data-activedataprovider.html#$query-detail">$query</a></td>
        <td><a href="yii-db-queryinterface.html">yii\db\QueryInterface</a></td>
        <td>The query that is used to fetch data models and <a href="yii-data-basedataprovider.html#$totalCount-detail">$totalCount</a>
if it is not explicitly set.</td>
        <td><a href="yii-data-activedataprovider.html">yii\data\ActiveDataProvider</a></td>
    </tr>
            <tr id="$queryResults">
        <td><a href="yii-elasticsearch-activedataprovider.html#$queryResults-detail">$queryResults</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>Full query results</td>
        <td><a href="yii-elasticsearch-activedataprovider.html">yii\elasticsearch\ActiveDataProvider</a></td>
    </tr>
            <tr class="inherited" id="$sort">
        <td><a href="yii-data-basedataprovider.html#$sort-detail">$sort</a></td>
        <td><a href="yii-data-sort.html">yii\data\Sort</a>|<a href="http://www.php.net/language.types.boolean">boolean</a></td>
        <td>The sorting object.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="$totalCount">
        <td><a href="yii-data-basedataprovider.html#$totalCount-detail">$totalCount</a></td>
        <td><a href="http://www.php.net/language.types.integer">integer</a></td>
        <td>Total number of possible data models.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
    </table>
</div>

<a id="methods"></a>

<div class="summary doc-method">
<h2>Public Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="__call()">
        <td><a href="yii-base-object.html#__call()-detail">__call()</a></td>
        <td>Calls the named method which is not a class method.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__clone()">
        <td><a href="yii-base-component.html#__clone()-detail">__clone()</a></td>
        <td>This method is called after the object is created by cloning an existing one.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__construct()">
        <td><a href="yii-base-object.html#__construct()-detail">__construct()</a></td>
        <td>Constructor.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__get()">
        <td><a href="yii-base-object.html#__get()-detail">__get()</a></td>
        <td>Returns the value of an object property.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__isset()">
        <td><a href="yii-base-object.html#__isset()-detail">__isset()</a></td>
        <td>Checks if a property is set, i.e. defined and not null.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__set()">
        <td><a href="yii-base-object.html#__set()-detail">__set()</a></td>
        <td>Sets value of an object property.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__unset()">
        <td><a href="yii-base-object.html#__unset()-detail">__unset()</a></td>
        <td>Sets an object property to null.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="attachBehavior()">
        <td><a href="yii-base-component.html#attachBehavior()-detail">attachBehavior()</a></td>
        <td>Attaches a behavior to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="attachBehaviors()">
        <td><a href="yii-base-component.html#attachBehaviors()-detail">attachBehaviors()</a></td>
        <td>Attaches a list of behaviors to the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="behaviors()">
        <td><a href="yii-base-component.html#behaviors()-detail">behaviors()</a></td>
        <td>Returns a list of behaviors that this component should behave as.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="canGetProperty()">
        <td><a href="yii-base-object.html#canGetProperty()-detail">canGetProperty()</a></td>
        <td>Returns a value indicating whether a property can be read.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="canSetProperty()">
        <td><a href="yii-base-object.html#canSetProperty()-detail">canSetProperty()</a></td>
        <td>Returns a value indicating whether a property can be set.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="className()">
        <td><a href="yii-base-object.html#className()-detail">className()</a></td>
        <td>Returns the fully qualified name of this class.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="detachBehavior()">
        <td><a href="yii-base-component.html#detachBehavior()-detail">detachBehavior()</a></td>
        <td>Detaches a behavior from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="detachBehaviors()">
        <td><a href="yii-base-component.html#detachBehaviors()-detail">detachBehaviors()</a></td>
        <td>Detaches all behaviors from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="ensureBehaviors()">
        <td><a href="yii-base-component.html#ensureBehaviors()-detail">ensureBehaviors()</a></td>
        <td>Makes sure that the behaviors declared in <a href="yii-base-component.html#behaviors()-detail">behaviors()</a> are attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="getAggregation()">
        <td><a href="yii-elasticsearch-activedataprovider.html#getAggregation()-detail">getAggregation()</a></td>
        <td>Returns results of the specified aggregation.</td>
        <td><a href="yii-elasticsearch-activedataprovider.html">yii\elasticsearch\ActiveDataProvider</a></td>
    </tr>
            <tr id="getAggregations()">
        <td><a href="yii-elasticsearch-activedataprovider.html#getAggregations()-detail">getAggregations()</a></td>
        <td></td>
        <td><a href="yii-elasticsearch-activedataprovider.html">yii\elasticsearch\ActiveDataProvider</a></td>
    </tr>
            <tr class="inherited" id="getBehavior()">
        <td><a href="yii-base-component.html#getBehavior()-detail">getBehavior()</a></td>
        <td>Returns the named behavior object.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="getBehaviors()">
        <td><a href="yii-base-component.html#getBehaviors()-detail">getBehaviors()</a></td>
        <td>Returns all behaviors attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="getCount()">
        <td><a href="yii-data-basedataprovider.html#getCount()-detail">getCount()</a></td>
        <td>Returns the number of data models in the current page.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="getKeys()">
        <td><a href="yii-data-basedataprovider.html#getKeys()-detail">getKeys()</a></td>
        <td>Returns the key values associated with the data models.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="getModels()">
        <td><a href="yii-data-basedataprovider.html#getModels()-detail">getModels()</a></td>
        <td>Returns the data models in the current page.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="getPagination()">
        <td><a href="yii-data-basedataprovider.html#getPagination()-detail">getPagination()</a></td>
        <td>Returns the pagination object used by this data provider.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr id="getQueryResults()">
        <td><a href="yii-elasticsearch-activedataprovider.html#getQueryResults()-detail">getQueryResults()</a></td>
        <td></td>
        <td><a href="yii-elasticsearch-activedataprovider.html">yii\elasticsearch\ActiveDataProvider</a></td>
    </tr>
            <tr class="inherited" id="getSort()">
        <td><a href="yii-data-basedataprovider.html#getSort()-detail">getSort()</a></td>
        <td>Returns the sorting object used by this data provider.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="getTotalCount()">
        <td><a href="yii-data-basedataprovider.html#getTotalCount()-detail">getTotalCount()</a></td>
        <td>Returns the total number of data models.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="hasEventHandlers()">
        <td><a href="yii-base-component.html#hasEventHandlers()-detail">hasEventHandlers()</a></td>
        <td>Returns a value indicating whether there is any handler attached to the named event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="hasMethod()">
        <td><a href="yii-base-object.html#hasMethod()-detail">hasMethod()</a></td>
        <td>Returns a value indicating whether a method is defined.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="hasProperty()">
        <td><a href="yii-base-object.html#hasProperty()-detail">hasProperty()</a></td>
        <td>Returns a value indicating whether a property is defined.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="init()">
        <td><a href="yii-data-activedataprovider.html#init()-detail">init()</a></td>
        <td>Initializes the DB connection component.</td>
        <td><a href="yii-data-activedataprovider.html">yii\data\ActiveDataProvider</a></td>
    </tr>
            <tr class="inherited" id="off()">
        <td><a href="yii-base-component.html#off()-detail">off()</a></td>
        <td>Detaches an existing event handler from this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="on()">
        <td><a href="yii-base-component.html#on()-detail">on()</a></td>
        <td>Attaches an event handler to an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="prepare()">
        <td><a href="yii-data-basedataprovider.html#prepare()-detail">prepare()</a></td>
        <td>Prepares the data models and keys.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
                        <tr class="inherited" id="refresh()">
        <td><a href="yii-data-basedataprovider.html#refresh()-detail">refresh()</a></td>
        <td>Refreshes the data provider.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="setKeys()">
        <td><a href="yii-data-basedataprovider.html#setKeys()-detail">setKeys()</a></td>
        <td>Sets the key values associated with the data models.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="setModels()">
        <td><a href="yii-data-basedataprovider.html#setModels()-detail">setModels()</a></td>
        <td>Sets the data models in the current page.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="setPagination()">
        <td><a href="yii-data-basedataprovider.html#setPagination()-detail">setPagination()</a></td>
        <td>Sets the pagination for this data provider.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr id="setQueryResults()">
        <td><a href="yii-elasticsearch-activedataprovider.html#setQueryResults()-detail">setQueryResults()</a></td>
        <td></td>
        <td><a href="yii-elasticsearch-activedataprovider.html">yii\elasticsearch\ActiveDataProvider</a></td>
    </tr>
            <tr class="inherited" id="setSort()">
        <td><a href="yii-data-activedataprovider.html#setSort()-detail">setSort()</a></td>
        <td>Sets the sort definition for this data provider.</td>
        <td><a href="yii-data-activedataprovider.html">yii\data\ActiveDataProvider</a></td>
    </tr>
            <tr class="inherited" id="setTotalCount()">
        <td><a href="yii-data-basedataprovider.html#setTotalCount()-detail">setTotalCount()</a></td>
        <td>Sets the total number of data models.</td>
        <td><a href="yii-data-basedataprovider.html">yii\data\BaseDataProvider</a></td>
    </tr>
            <tr class="inherited" id="trigger()">
        <td><a href="yii-base-component.html#trigger()-detail">trigger()</a></td>
        <td>Triggers an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
    </table>
</div>

<div class="summary doc-method">
<h2>Protected Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
                                                                                                                                                <tr class="inherited" id="prepareKeys()">
        <td><a href="yii-data-activedataprovider.html#prepareKeys()-detail">prepareKeys()</a></td>
        <td>Prepares the keys associated with the currently available data models.</td>
        <td><a href="yii-data-activedataprovider.html">yii\data\ActiveDataProvider</a></td>
    </tr>
            <tr id="prepareModels()">
        <td><a href="yii-elasticsearch-activedataprovider.html#prepareModels()-detail">prepareModels()</a></td>
        <td>Prepares the data models that will be made available in the current page.</td>
        <td><a href="yii-elasticsearch-activedataprovider.html">yii\elasticsearch\ActiveDataProvider</a></td>
    </tr>
            <tr id="prepareTotalCount()">
        <td><a href="yii-elasticsearch-activedataprovider.html#prepareTotalCount()-detail">prepareTotalCount()</a></td>
        <td>Returns a value indicating the total number of data models in this data provider.</td>
        <td><a href="yii-elasticsearch-activedataprovider.html">yii\elasticsearch\ActiveDataProvider</a></td>
    </tr>
                                    </table>
</div>

<a id="events"></a>

<a id="constants"></a>

<h2>Property Details</h2>

<div class="property-doc">

    <div class="detail-header h3" id="$aggregations-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activedataprovider.html#$aggregations-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveDataProvider.php" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveDataProvider.php" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $aggregations        <span class="detail-header-tag small">
            public                         <em>read-only</em>                         property
                    </span>
    </div>

    <div class="doc-description">
        <p>All aggregations results</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yii-elasticsearch-activedataprovider.html#getAggregations()-detail">getAggregations</a></strong> ( )</div>


    <div class="detail-header h3" id="$queryResults-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activedataprovider.html#$queryResults-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveDataProvider.php" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveDataProvider.php" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $queryResults        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>Full query results</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yii-elasticsearch-activedataprovider.html#getQueryResults()-detail">getQueryResults</a></strong> ( )<br /><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-elasticsearch-activedataprovider.html#setQueryResults()-detail">setQueryResults</a></strong> ( <span style="color: #0000BB">$results</span> )</div>

</div>
<h2>Method Details</h2>

<div class="method-doc">

    <div class="detail-header h3" id="getAggregation()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activedataprovider.html#getAggregation()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveDataProvider.php#L69" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveDataProvider.php#L69" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        getAggregation()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Returns results of the specified aggregation.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yii-elasticsearch-activedataprovider.html#getAggregation()-detail">getAggregation</a></strong> ( <span style="color: #0000BB">$name</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$name</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Aggregation name.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Aggregation results.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-base-invalidcallexception.html">yii\base\InvalidCallException</a></td>
                  <td class="param-desc-col"><p>if requested aggregation does not present in query results.</p>
</td>
                </tr>
                        </table>

<!--	-->

    <div class="detail-header h3" id="getAggregations()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activedataprovider.html#getAggregations()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveDataProvider.php#L57" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveDataProvider.php#L57" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        getAggregations()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yii-elasticsearch-activedataprovider.html#getAggregations()-detail">getAggregations</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>All aggregations results</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="getQueryResults()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activedataprovider.html#getQueryResults()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveDataProvider.php#L46" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveDataProvider.php#L46" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        getQueryResults()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yii-elasticsearch-activedataprovider.html#getQueryResults()-detail">getQueryResults</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Full query results</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="prepareModels()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activedataprovider.html#prepareModels()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveDataProvider.php#L81" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveDataProvider.php#L81" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        prepareModels()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Prepares the data models that will be made available in the current page.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yii-elasticsearch-activedataprovider.html#prepareModels()-detail">prepareModels</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The available data models</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="prepareTotalCount()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activedataprovider.html#prepareTotalCount()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveDataProvider.php#L110" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveDataProvider.php#L110" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        prepareTotalCount()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Returns a value indicating the total number of data models in this data provider.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.integer">integer</a></span> <strong><a href="yii-elasticsearch-activedataprovider.html#prepareTotalCount()-detail">prepareTotalCount</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.integer">integer</a></td>
                  <td class="param-desc-col"><p>Total number of data models in this data provider.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="setQueryResults()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-elasticsearch-activedataprovider.html#setQueryResults()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-elasticsearch/edit/master/ActiveDataProvider.php#L38" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveDataProvider.php#L38" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        setQueryResults()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-elasticsearch-activedataprovider.html#setQueryResults()-detail">setQueryResults</a></strong> ( <span style="color: #0000BB">$results</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$results</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Full query results</p>
</td>
                </tr>
                                                </table>

<!--	-->
</div>
        </div>
</div>

<script type="text/javascript">
    /*<![CDATA[*/
    $("a.toggle").on('click', function () {
        var $this = $(this);
        if ($this.hasClass('properties-hidden')) {
            $this.text($this.text().replace(/Show/,'Hide'));
            $this.parents(".summary").find(".inherited").show();
            $this.removeClass('properties-hidden');
        } else {
            $this.text($this.text().replace(/Hide/,'Show'));
            $this.parents(".summary").find(".inherited").hide();
            $this.addClass('properties-hidden');
        }

        return false;
    });
    /*
     $(".sourceCode a.show").toggle(function () {
     $(this).text($(this).text().replace(/show/,'hide'));
     $(this).parents(".sourceCode").find("div.code").show();
     },function () {
     $(this).text($(this).text().replace(/hide/,'show'));
     $(this).parents(".sourceCode").find("div.code").hide();
     });
     $("a.sourceLink").click(function () {
     $(this).attr('target','_blank');
     });
     */
    /*]]>*/
</script>


</div>

<footer class="footer">
        <p class="pull-right"><small>Page generated on Sat, 09 Jul 2016 12:15:55 +0000</small></p>
    Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a></footer>

<script type="text/javascript">jQuery(document).ready(function () {
    var shiftWindow = function () { scrollBy(0, -50) };
    if (location.hash) setTimeout(shiftWindow, 1);
    window.addEventListener("hashchange", shiftWindow);
var element = document.createElement("script");
element.src = "./jssearch.index.js";
document.body.appendChild(element);

var searchBox = $('#searchbox');

// search when typing in search field
searchBox.on("keyup", function(event) {
    var query = $(this).val();

    if (query == '' || event.which == 27) {
        $('#search-resultbox').hide();
        return;
    } else if (event.which == 13) {
        var selectedLink = $('#search-resultbox a.selected');
        if (selectedLink.length != 0) {
            document.location = selectedLink.attr('href');
            return;
        }
    } else if (event.which == 38 || event.which == 40) {
        $('#search-resultbox').show();

        var selected = $('#search-resultbox a.selected');
        if (selected.length == 0) {
            $('#search-results').find('a').first().addClass('selected');
        } else {
            var next;
            if (event.which == 40) {
                next = selected.parent().next().find('a').first();
            } else {
                next = selected.parent().prev().find('a').first();
            }
            if (next.length != 0) {
                var resultbox = $('#search-results');
                var position = next.position();

//              TODO scrolling is buggy and jumps around
//                resultbox.scrollTop(Math.floor(position.top));
//                console.log(position.top);

                selected.removeClass('selected');
                next.addClass('selected');
            }
        }

        return;
    }
    $('#search-resultbox').show();
    $('#search-results').html('<li><span class="no-results">No results</span></li>');

    var result = jssearch.search(query);

    if (result.length > 0) {
        var i = 0;
        var resHtml = '';

        for (var key in result) {
            if (i++ > 20) {
                break;
            }
            resHtml = resHtml +
            '<li><a href="' + result[key].file.u.substr(3) +'"><span class="title">' + result[key].file.t + '</span>' +
            '<span class="description">' + result[key].file.d + '</span></a></li>';
        }
        $('#search-results').html(resHtml);
    }
});

// hide the search results on ESC
$(document).on("keyup", function(event) { if (event.which == 27) { $('#search-resultbox').hide(); } });
// hide search results on click to document
$(document).bind('click', function (e) { $('#search-resultbox').hide(); });
// except the following:
searchBox.bind('click', function(e) { e.stopPropagation(); });
$('#search-resultbox').bind('click', function(e) { e.stopPropagation(); });

});</script></body>
</html>
